home *** CD-ROM | disk | FTP | other *** search
/ Windows Expert / Windows Expert.iso / windownt / rcsdoc.zip / READ.ME < prev    next >
Text File  |  1993-09-05  |  5KB  |  107 lines
  1. This is the latest version of the Free Software Foundations's 
  2. Revision Control System (version 5.6). It was ported to NT as 
  3. part of research for a PC Week Labs article on free software. It
  4. is *not* an example of good programming, since I'm far from a 
  5. professional C programmer. It also hasn't been tested that 
  6. extensively, although I've been using it for a month or so and the
  7. basic commands seem to work as expected. 
  8.  
  9. CAVEATS: There are a few. One is that it only works on text files. 
  10. In fact, if you try to "checkin" or "checkout" a binary file, it will 
  11. truncate the file without warning. Another is that these programs only 
  12. take the '-' character as an option delimiter on the command line. They
  13. won't work with the '/' character. Finally, this release has only
  14. been tested on intel with NTFS. In fact, it won't work on FAT, because
  15. the RCS files use ",v" as the extension.
  16.  
  17. Of course, RCS comes with no warranty whatsoever, not even for fitness
  18. for a particular purpose. See the file COPYING for the GNU's copyright.
  19.  
  20. I got the original source from the UNIXFORUM on Compuserve. The file
  21. CHANGES.NT shows the mostly unnecessary changes I made to the original
  22. source. I changed things like k&r function declarations to ansi C style
  23. (in anticipation of making this part of a DLL or C++ program some day), 
  24. added explicit casts everywhere to get rid of compiler warnings, and 
  25. changed the default file-open mode to text instead of binary. The last
  26. change was necessary to get around the problem of Unix line endings 
  27. (which end in \n, instead of \r\n). Without that change, I would have had
  28. to make numerous other changes throughout the source code. Please do let
  29. me know if you have found a better way to port this source.
  30.  
  31. The distribution includes three zip files:
  32. rcs56nt.zip -- the binary files.
  33. rcssrc.zip -- source code. The original source code is in CIS:UNIXFORUM. 
  34.               See the Changes.nt file for the changes I made to the original
  35.               source.
  36. rcsdoc.zip -- The documentation files I got from the DOS port of RCS. These
  37.               files document version 5.5 of RCS, but that's close enough.
  38.               For the absolute minimum you need to know to get started, see
  39.               below.
  40.  
  41. You also need the NT ports of diff and diff3, which I uploaded separately.
  42.  
  43. What you absolutely need to know to get started.
  44. ------------------------------------------------
  45.  
  46. Put the binaries for RCS, along with diff.exe and diff3.exe, into a directory
  47. on your path. Add two variables to your environment using the system icon
  48. in the control panel. One is LOGNAME, which should be set to your login name.
  49. The other is TZ, which is the time zone your in. Mine is set to EST5EDT. Set
  50. yours appropriately.
  51.  
  52. To use RCS on a particular directory of source code, create a directory
  53. below the source code called RCS. Check in the initial version of all the
  54. text files with the "ci" command (without the quotes). For example, 
  55.  
  56. ci *.c *.h *.mak
  57.  
  58. will check in the source files for the typical project written in C. If this
  59. is the first time you checked those files in, ci will prompt you for a 
  60. description of the file. If you have changed the file since you last
  61. checked it in, you will be prompted for a log message. If you put a log
  62. area on the top of your source, file, rcs will automatically update this 
  63. to show all the log messages. For example, add the following at the top of 
  64. all of your C source and headers:
  65.  
  66. /* $Log: $
  67. */
  68.  
  69. This will be exanded by the co command (see below) to a listing of all of 
  70. the log messages used when checking in the file. For example, look at the 
  71. source files for RCS.
  72.  
  73. IMPORTANT: Remember this version of RCS does not work with binary files, so
  74. don't try to check in all the misc. junk generated by your compiler (such
  75. as *.sbr and other stuff created by Visual C++). 
  76.  
  77. To check the files out again for editing, use the "co" command. For example,
  78.  
  79. co -l RCS\*.*
  80.  
  81. The -l option puts a lock on the files in your name so that no one can over-
  82. write your changes. If you omit the -l option, co will create read-only copies
  83. of the latest version of each file. You can also use "ci -l" to checkin 
  84. the current files as a new version and automatically check them out again
  85. with a lock. 
  86.  
  87. What some of the other commands do.
  88. -----------------------------------
  89.  
  90. RCSDIFF -- shows you the changes you've made since you checked out a file.
  91. run "rcsdiff <sourcefile>" and it will dump out a diff listing of your changes.
  92. This is useful before checking in a new version, to remind you of the changes
  93. you made before writing a log message.
  94.  
  95. RLOG -- shows you all of the log messages and other RCS information stored for
  96. a particular file. For example, running "rlog ci.c" will show you all of the 
  97. revision logs for ci.c, as well as the username of the person who owns a "lock" 
  98. on the file.
  99.  
  100. That's enough to get you started. Read the docs for more information. I would
  101. be interested in hearing from anyone who improves on this initial port.
  102.  
  103. -Eamonn Sullivan
  104.  PC Week Labs senior technical analyst.
  105.  
  106.  
  107.